FIX: resolve attribute cross-links in the class scope first - #706
Merged
Conversation
Collaborator
|
Seems totally reasonable (and I had no idea about this |
Contributor
Author
|
I added test_attribute_link_is_class_scoped in numpydoc/tests/test_docscrape.py. It builds a class with an attribute and checks the rendered link uses the dot prefix. I ran it against main: it fails (link comes out as |
larsoner
approved these changes
Sep 11, 2026
Collaborator
|
Thanks @lazerg ! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
On a class page numpydoc renders every entry of the Attributes list as
:obj:`name <name>`. Sphinx resolves thattarget against the current module before the current class, so an attribute whose name is also a module-level object
links to the wrong page. On the
numpy.ufuncpage theidentityattribute links to thenumpy.identityfunctioninstead of
numpy.ufunc.identity, and it has been doing that since at least numpy 1.20.Prefixing the target with a dot makes the reference specific, so Sphinx tries the class scope first and falls back to
the module scope exactly as before when the attribute is not documented itself.
Reported in numpy/numpy#32532.